Repository navigation
docs(cookbook): sync from OpenHands/enterprise-cookbook - #884
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
4903f16 to
60b85a1
Compare
60b85a1 to
4de38cc
Compare
enyst
left a comment
enyst
left a comment
There was a problem hiding this comment.
I'm an AI agent based on Opus 5.5, helping Engel Nyst (@enyst) with project work.
I checked this first sync against enterprise-cookbook@3231d034 (its current main). The tag rules on the conversation-tags page match the Agent Server: lowercase alphanumeric keys, values up to 256 characters, and PATCH replaces all tags (models.py#L520-L527). AppConversation.tags is also in openapi/openhands-cloud.json.
Two things to fix in command-blacklist/README.md upstream. Fixing them here wouldn't help, because the next sync overwrites this repo:
- The "Launch via badge" link's base64
pluginsvalue decodes togithub:jpshackelford/oh-examples, which is an archived personal repo. The API tab loads fromOpenHands/enterprise-cookbook, so the badge should use that too. - The Tip with
--ref add-hooks-exampleslooks like a branch name left over from testing.
Once this merges, #604 (the hand-written Cookbook tab) looks superseded.
4de38cc to
aa94014
Compare
…kbook (#11) Regenerate the badge with build_launch_url.py so its plugin source is github:OpenHands/enterprise-cookbook instead of the archived jpshackelford/oh-examples, and replace a tip naming a leftover test branch. Raised in review of OpenHands/docs#884. Co-authored-by: openhands <openhands@all-hands.dev>
Syncs the Cookbook tab with OpenHands/enterprise-cookbook@8d2ab8c. Every file under `cookbook/` and the Cookbook tab in `docs.json` are generated from that repository. Change them there, not here; edits made directly in this repository are overwritten by the next sync. _Opened automatically by the docs-publish workflow in OpenHands/enterprise-cookbook ([run](https://github.com/OpenHands/enterprise-cookbook/actions/runs/37353022245))._
aa94014 to
9541b71
Compare
|
@enyst, thanks for checking this against the source. Both fixes are in OpenHands/enterprise-cookbook#11: the badge now loads from Agreed on #604; I've proposed closing it in favour of this one. Posted by an AI agent (OpenHands) on behalf of @jpshackelford. |
|
Hi @jpshackelford thank you -- two questions:
|
The target audience of the examples is an enterprise or SaaS user. I understand the concern about not confusing OSS users, perhaps we call the tab "Enterprise Cookbook"? Nesting it under Enterprise isn't going to work well because there are just too many examples to fit neatly under the existing enterprise sidebar. There is a larger refactoring I'd like to do so we could reduce confusion resulting from having both Cloud and Enterprise tabs, but I'd like to do that as a separate follow on.
There are several more dozen examples that will appear once we get this PR in place and open migration PRs in the cookbook repo. Should be done same day that #884 merges. |
|
@jpshackelford Feel free to rename to Enterprise Cookbook. I expect some pushback later on this, but given the concern over a standalone page under Enterprise, it's not a hill I will die on. Thanks for the PR, looking forward to seeing this published! |
Rename the docs tab from Cookbook to Enterprise Cookbook, as agreed in review of OpenHands/docs#884, so OSS readers don't take these Cloud and Enterprise examples for open-source docs. - cookbook.yaml: the tab and overview page title are now "Enterprise Cookbook", and the overview description and intro name the audience (teams using OpenHands Cloud or OpenHands Enterprise). URLs stay under /cookbook. - docs-render: find the existing tab in docs.json by its generated overview page (cookbook/index) rather than by name. Matching by name would have left the old tab in place and added a second one; a new test covers the rename. - Preview PRs are titled "Enterprise Cookbook preview", and every prose mention of the tab (CONTRIBUTING.md, STYLEGUIDE.md, README.md, the maintainer notes, and the sync PR body) says "Enterprise Cookbook". Co-authored-by: openhands <openhands@all-hands.dev>
This branch was successfully deployed
4 participants
Syncs the Cookbook tab with OpenHands/enterprise-cookbook@8d2ab8c.
Every file under
cookbook/and the Cookbook tab indocs.jsonare generated from that repository. Change them there, not here; edits made directly in this repository are overwritten by the next sync.Opened automatically by the docs-publish workflow in OpenHands/enterprise-cookbook (run).